org.springframework.core.io.support

Class EncodedResource

java.lang.Object

org.springframework.core.io.support.EncodedResource

public class EncodedResource
extends java.lang.Object

Holder that combines a Resource with a specific encoding to be used for reading from the resource.

Used as argument for operations that support to read content with a specific encoding (usually through a java.io.Reader).

Since:

1.2.6

Author:

Juergen Hoeller

See Also:

Reader

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.charset.Charset	charset
private java.lang.String	encoding
private Resource	resource

Constructor Summary

Constructors

Constructor and Description
EncodedResource(Resource resource) Create a new EncodedResource for the given Resource, not specifying a specific encoding.
EncodedResource(Resource resource, java.nio.charset.Charset charset) Create a new EncodedResource for the given Resource, using the specified encoding.
EncodedResource(Resource resource, java.lang.String encoding) Create a new EncodedResource for the given Resource, using the specified encoding.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.nio.charset.Charset	getCharset() Return the charset to use for reading from the resource, or null if none specified.
java.lang.String	getEncoding() Return the encoding to use for reading from the resource, or null if none specified.
java.io.InputStream	getInputStream() Open an java.io.InputStream for the specified resource, typically assuming that there is no specific encoding to use.
java.io.Reader	getReader() Open a java.io.Reader for the specified resource, using the specified encoding (if any).
Resource	getResource() Return the Resource held.
int	hashCode()
boolean	requiresReader() Determine whether a Reader is required as opposed to an InputStream, i.e.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

resource

private final Resource resource

encoding

private java.lang.String encoding

charset

private java.nio.charset.Charset charset

Constructor Detail

EncodedResource

public EncodedResource(Resource resource)

Create a new EncodedResource for the given Resource, not specifying a specific encoding.

Parameters:

resource - the Resource to hold

EncodedResource

public EncodedResource(Resource resource,
                       java.lang.String encoding)

Create a new EncodedResource for the given Resource, using the specified encoding.

Parameters:

resource - the Resource to hold

encoding - the encoding to use for reading from the resource

EncodedResource

public EncodedResource(Resource resource,
                       java.nio.charset.Charset charset)

Create a new EncodedResource for the given Resource, using the specified encoding.

Parameters:

resource - the Resource to hold

charset - the charset to use for reading from the resource

Method Detail

getResource

public final Resource getResource()

Return the Resource held.

getEncoding

public final java.lang.String getEncoding()

Return the encoding to use for reading from the resource, or null if none specified.

getCharset

public final java.nio.charset.Charset getCharset()

Return the charset to use for reading from the resource, or null if none specified.

requiresReader

public boolean requiresReader()

Determine whether a Reader is required as opposed to an InputStream, i.e. whether an encoding or a charset has been specified.

See Also:

getReader(), getInputStream()

getReader

public java.io.Reader getReader()
                         throws java.io.IOException

Open a java.io.Reader for the specified resource, using the specified encoding (if any).

Throws:

java.io.IOException - if opening the Reader failed

See Also:

requiresReader()

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Open an java.io.InputStream for the specified resource, typically assuming that there is no specific encoding to use.

Throws:

java.io.IOException - if opening the InputStream failed

See Also:

requiresReader()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object